<?php
///////////////////////////////////////////////////////////////////////////////////////////////////////
//  这个文件是 JCAT PHP框架的一部，该项目和此文件 均遵循 GNU 自由软件协议
// 
//  Copyleft 2008 JeCat.cn(http://team.JeCat.cn)
//
//
//  JCAT PHP框架 的正式全名是：Jellicle Cat PHP Framework。
//  “Jellicle Cat”出自 Andrew Lloyd Webber的音乐剧《猫》（《Prologue:Jellicle Songs for Jellicle Cats》）。
//  JCAT 是一个开源项目，它像音乐剧中的猫一样自由，你可以毫无顾忌地使用JCAT PHP框架。JCAT 由中国团队开发维护。
//  正在使用的这个版本是：0.5.0 / SVN信息: $Id: class.JCAT_FSPreferenceKeyIterator.php 1604 2009-03-31 15:40:17Z alee $
//
//
//
//  相关的链接：
//    [主页] http://jcat.JeCat.cn
//    [下载(HTTP)] http://code.google.com/p/jcat-php/downloads/list
//    [下载(svn)] svn checkout http://jcat-php.googlecode.com/svn/branches/0.4.0/Framework/ JCAT0.4
//    [在线文档] http://jcat.JeCat.cn/document
//    [社区] http://jj.jecat.cn/forum-7-1.html
//  不很相关：
//    [MP3] http://www.google.com/search?q=jellicle+songs+for+jellicle+cats+Andrew+Lloyd+Webber
//    [VCD/DVD] http://www.google.com/search?q=CAT+Andrew+Lloyd+Webber+video
//
///////////////////////////////////////////////////////////////////////////////////////////////////////
/*-- Project Introduce --*/




/**
 * 迭代器接口
 *
 * @author		alee
 * @access		public
 */
class JCAT_FSPreferenceKeyIterator extends JCAT_FSOIterator
{
	/**
	 * 构造函数
	 *
	 * @access	public
	 * @param	$aPreferenceKey		JCAT_FSPreferenceKey
	 * @return	void
	 */
	public function JCAT_FSPreferenceKeyIterator(JCAT_FSPreferenceKey $aPreferenceKey)
	{
		parent::JCAT_FSOIterator($aPreferenceKey->GetFSPath(),JCAT_FSOIterator::DIR|JCAT_FSOIterator::RETURN_NAME|JCAT_FSOIterator::RETURN_PATH) ;
	}

	/**
	 * 返回第一项，迭代开始
	 * 
	 * @access	public
	 * @return	JCAT_FSPreferenceKey
	 */
	public function First() 
	{
		return JCAT_FSOIterator::First() ;
	}

	/**
	 * 迭代之下一个
	 * 
	 * @access	public
	 * @return	JCAT_FSPreferenceKey
	 */
	public function Next() 
	{
		// 确保是可用的 Key目录
		$sNextPath = JCAT_FSOIterator::Next() ;
		while ( !self::VerifyDirForKey($sNextPath) )
		{
			$sNextPath = JCAT_FSOIterator::Next() ;
		}
		
		if($sNextPath===null)
		{
			return null ;
		}
		
		else
		{
			return new JCAT_FSPreferenceKey($sNextPath) ;
		}
	}

	/**
	 * 返回当前内容
	 * 
	 * @access	public
	 * @return	JCAT_FSPreferenceKey
	 */
	public function Current()
	{
		$sCurrentPath = JCAT_FSOIterator::Current() ;
		if($sCurrentPath===null)
		{
			return null ;
		}
		
		else
		{
			return new JCAT_FSPreferenceKey($sCurrentPath) ;
		}
	}
	
	/**
	 * 检查是否 Key 目录
	 *
	 * @access	public
	 * @param	$sDirPath	string
	 * @static
	 * @return	void
	 */
	static public function VerifyDirForKey($sDirPath)
	{
		$sDirName = basename($sDirPath) ;
		return substr($sDirName,0,1)!=='.' ;
	}
}
?>